home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 011 / cats22.arc / CATS22.DOC < prev    next >
Encoding:
Text File  |  1987-01-19  |  35.2 KB  |  753 lines

  1.  
  2.                 CATS - A Multi-Disk Cataloging Utility
  3.  
  4.                              Version 2.2
  5.  
  6.              by William C. Parke (c) Copyright 1986,1987
  7.                  for CHUG, Capital Heath Users' Group
  8.                     P.O. Box 16406, Arlington, Va.
  9.                               22215-1406
  10.  
  11.                     Suggestions for Improvement by
  12.  
  13.                             Jerry Horwitz
  14.                             Douglas Clark
  15.                                  and
  16.                              Larry Sites
  17.  
  18.                                of CHUG
  19.  
  20.                                    
  21. ACKNOWLEDGEMENTS:
  22.  
  23. This document  has been review and edited by Jerry Horwitz, CHUG MSDOS
  24. SIG Coordinator  Emeritus, who  made many  corrections and  additions.
  25. Jerry also  tested the  program, and  made many useful suggestions for
  26. enhancing it.
  27.  
  28. Douglas Clark,  the new  CHUG MSDOS  SIG Coordinator, spent many hours
  29. testing the  program and  thinking of ways to improve it. His incisive
  30. mind led to the correction of a very difficult to find program bug.
  31.  
  32. The author consulted with the CHUG SYSOP Emeritus, Larry Sites, during
  33. program development to gain from his wisdom.
  34.  
  35. INTRODUCTION:
  36.  
  37. CATS is  a directory-cataloging  program for  MS-DOS computer systems.
  38. CATS will generate a catalog file which lists the volume label and all
  39. directories and files on each disk selected by the user for cataloging
  40. (including floppy  diskettes, hard-disk partitions, and RAM disks). If
  41. the catalog  file exists,  CATS will append the new data to it. If the
  42. catalog file does not exist, CATS will create it.
  43.  
  44. The listing  for each  file on the disks cataloged is in the form of a
  45. record consisting  of one  line  in  the  catalog  file.  This  record
  46. includes fields for the filename and extension, an abbreviated listing
  47. of attributes,  size, date  and time of last write, disk volume label,
  48. path, and  space for  special comments  (which can  be added  with  an
  49. editor) about  each file to identify its purpose. The catalog file can
  50. be sorted  according to  any or  all of  these fields  by means of the
  51. sorting utility  SORTS supplied  with CATS.  Cataloging your removable
  52. disks will  give you  the ability  to find any file in your library of
  53. disks by  simply using an editor or file listing utility to search the
  54. catalog for the desired file. As disks are modified, their directories
  55. can be  added to  the catalog and, by sorting on the volume label, the
  56. catalog can  be edited  to remove  obsolete entries. This obviates the
  57. need for rebuilding a large catalog from scratch.
  58.  
  59. The advantages of CATS over other cataloging programs include:
  60.  
  61. 1. Speed:  CATS was  written in  assembly language,  and operates very
  62. quickly.
  63.  
  64. 2. Multiple  drives: CATS lets you use any number of drives. While one
  65. is being used, another can be loaded with a new disk.  CATS works with
  66. any drives supported by the operating system.
  67.  
  68. 3. Ease  of use:  CATS provides  explicit  instructions  and  detailed
  69. information on  what operation  it is  performing. A minimal number of
  70. keystrokes is used for each command.
  71.  
  72. 4. Flexibility: You can use a different catalog file each time CATS is
  73. run. The  default catalog  file name  and its  format  can be changed.
  74. CATS and  the catalog  file can be in different directories or even on
  75. different disks.
  76.  
  77. 5. Universality: CATS should run on any generic MS-DOS computer.
  78.  
  79. 6. Useful  format: The  catalog file  will have  a fixed record format
  80. with fields  for all  useful directory  data and  is  suitable  for  a
  81. sorting program to operate on any or all of these fields.
  82.  
  83. 7. Handles  many disks:  The catalog  file  is  limited  only  by  the
  84. capability of the selected sorting program and by available disk space
  85. to store  the catalog  (nominally 80  bytes per  record, including the
  86. carriage return and line feed). CATS puts no limit on the catalog file
  87. size.
  88.  
  89. INVOKING CATS
  90.  
  91. Before running CATS, .change its name from CATS??.COM on your disk to
  92. CATS.COM.
  93.  
  94. The command syntax for CATS is:
  95.  
  96.    CATS x: [catname][/s]
  97.  
  98. where   x:    is a valid drive name for the disk you wish cataloged,
  99.               and
  100.    [catname]  is the optional drive:\path\filename for your catalog
  101.               file.
  102.    If no catname is given, the default: \CAT\CATS.DIR is used.
  103.    [/s] represents optional switches. s=
  104.         V  to Verify current disk volume label,
  105.         N  to Not write your new volume label onto current disk,
  106.         M  to Make sequential numerical volume labels,
  107.         D  to Display disk files onto the console,
  108.         F  to Force a comma Field separator,
  109.         C  to Change the default catname
  110.                   within CATS.COM stored on your disk drive.
  111.                   (No drive name x: is needed for this option.)
  112.         All switches can be combined (e.g. /NVDC ).
  113.  
  114. Note that  the entry  for the  drive name  of the drive containing the
  115. disk to  be cataloged must be provided, unless the switch 'C' is used.
  116. However, the  entry associated  with the  catalog  file  (catname)  is
  117. optional. If  no catalog  file is  given,  the  default  catalog  file
  118. \CAT\CATS.DIR will  be used. This default name can be changed with the
  119. 'C' switch.  All of the switches are optional.
  120.  
  121. CATS.COM must  reside in  the current  directory  or  in  a  directory
  122. defined in  the search PATH. The directory containing the catalog file
  123. must exist  and must be reachable from the current drive\directory. If
  124. CATS.COM resides  in a  directory  defined  in  the  search  PATH  and
  125. "catpath" reaches  the directory  containing the catalog file from the
  126. root directory, you can run CATS from any subdirectory.
  127.  
  128. EXAMPLES OF USE
  129.  
  130. To catalog the disk in drive B: into the default catalog file, use the
  131. command
  132.  
  133.         CATS B:
  134.  
  135. (This form  assumes that  the directory containing the default catalog
  136. file is  reachable from  the current drive and directory.) The catalog
  137. list of  all files  on B:  will be  placed in the default catalog file
  138. (\CAT\CATS.DIR on  the default  drive, unless the user has changed the
  139. default). If  the catalog  file is not found, you will be asked if you
  140. wish it  to be  created. In order for CATS to create the catalog file,
  141. the given directory path must exist.
  142.  
  143. To catalog  the disk  in drive  B: into  a catalog file other than the
  144. default file,  such as  SPECIAL.DIR on  the disk  in drive A:, use the
  145. command:
  146.  
  147.         CATS B: A:SPECIAL.DIR
  148.  
  149. This will add the information for the files on the disk in drive B: to
  150. the catalog file SPECIAL.DIR on the disk in drive A:.
  151.  
  152. To catalog  a series  of disks  using drive  A:, verifying each volume
  153. label, electing  to display  the disk  files on  the  console,  making
  154. volume serial  numbers, and  not writing  the new volume labels on the
  155. disk, use:
  156.  
  157.      CATS A: /VDMN
  158.  
  159. The catalog for this series of disks will be appended to the default
  160. catalog.
  161.  
  162. More on Command-Line Switches
  163.  
  164. CATS can  be invoked  using one  or more of the available command-line
  165. switches. Example valid forms for invoking these switches include
  166.  
  167.         /V        for the single switch V
  168.         /VNM      for three switches
  169.         /V /N /M  for the same three switches as the previous case
  170.  
  171. Volume Label Verify Switch /V
  172.  
  173. The V  switch allows  you change the volume label on the disks you are
  174. cataloging, even  if these  disks already  have a  volume  label.  For
  175. example, the command
  176.  
  177.         CATS A: /V
  178.  
  179. causes CATS to first read the volume label on the disk in drive A:. If
  180. one is  not found, you will be asked to supply one. If one is present,
  181. you will be shown it and asked if you wish to change it. If you answer
  182. Y for  yes, you will be asked to supply a new name. A volume label can
  183. contain all valid file name characters:
  184.  
  185.        A-Z 0-9 $ & # % ' ( ) - @ ^ { } ~ ` ! and _.
  186.  
  187. In addition,  spaces can  be used.  Lower case  letters are  mapped to
  188. upper case.  The /V  switch allows  you to  relabel your  disks  in  a
  189. logical fashion  according to the order you have arranged them.  After
  190. the volume label is changed (if you answered Y for yes), CATS catalogs
  191. the files on the disk.
  192.  
  193. No Write Volume Label Switch /N
  194.  
  195. The N  switch prevents CATS from writing any new volume label onto the
  196. disk itself. This is useful for cataloging write-protected disks which
  197. have no  labels, to  catalog low  density disks in high density drives
  198. (which should  not write to those disks, but can read them), to make a
  199. catalog with  disk labels which do not correspond to volume labels, or
  200. to catalog  duplicate disks  which you wish to catalog separately. The
  201. labels you  choose to  display in  the catalog file should be noted on
  202. the disk  paper labels,  so that  you can  identify the  physical disk
  203. which corresponds  to a given catalog entry. They do not have to match
  204. the volume label on the disk.
  205.  
  206. Make Sequential Numerical Volume Labels Switch /M
  207.  
  208.  The  M switch is used to automatically label disks with a sequence of
  209. numbers.   The first  eight characters  of the volume label can be any
  210. name which  applies to  a set of disks.  The last three characters are
  211. reserved for  a three  digit number.   CATS  will prompt  you for  the
  212. volume set name and the beginning serial number.  Each succeeding disk
  213. cataloged will  be given the same eight character name but with  a new
  214. serial number,  incremented by  one from  the previous disk.  By using
  215. both the  V and  M switches,  several sets of disks with different set
  216. names can  be catalogued  in one CATS session, with arbitrary starting
  217. serial numbers.
  218.  
  219. If you  have over  999 disks in one set, CATS will use one more of the
  220. eleven characters  to establish  a proper  serial number,  letting you
  221. catalog up  to 10,000  disks in  one series.   With  both the  V and M
  222. switches on,  CATS will prompt you to verify the new disk volume label
  223. while maintaining  a volume  serial number.  If the new label given is
  224. satisfactory, you need not change it. However, you may elect to change
  225. the volume  set name  or the serial number. CATS will use your name to
  226. begin a new series of numbered labels.
  227.  
  228. Force a Comma Field Separator /F
  229.  
  230. The fields  in a  CATS catalog  are the divisions of each catalog line
  231. which show  a particular  aspect of  a file.  The filename, attribute,
  232. size, creation  date, etc.  are all  considered separate  fields.  The
  233. default field  separator in  CATS is  an single  space.   Other  field
  234. separation characters  would make  the catalog  less readable  to  the
  235. human eye,  but possibly more useful if the catalog file is to be used
  236. as input  to a  data base  or spreadsheet  program.   A popular  field
  237. separator for  these type  of programs is a comma.  By applying the /F
  238. switch on  the command line of CATS, a comma will be used instead of a
  239. space to  separate fields on each new catalog line.  An alternative to
  240. the /F switch is a patch to CATS which will change the field separator
  241. to any character you choose.  Such patches are described later in this
  242. document.
  243.  
  244. Display the Current Disk Files onto the Console /D
  245.  
  246. If the  D switch  is selected,  CATS will let you display the files on
  247. the current  disk onto  your console  screen.  If the V switch is also
  248. active, this file list will be given to you before you are asked for a
  249. new volume  label.   In this way, you can review the files on the disk
  250. before deciding on a new volume label.
  251.  
  252. Change the Default Catalog File Name /C
  253.  
  254. The C  switch lets you change the default catalog file name within the
  255. CATS.COM program.   The catalog file is used by CATS to store the disk
  256. file catalogs.   If  you have several distinct group of disks, you may
  257. wish to  have a  separate catalog  file for  each group.   Setting the
  258. default catalog file name to match one group of disks will mean you do
  259. not have  to give that name on the command line while cataloging disks
  260. in that group.
  261.  
  262. If the  C switch is used without any other character, CATS will prompt
  263. you for  a new catalog name.  CATS will accept only valid subdirectory
  264. names in the catalog path name.
  265.  
  266. All of  the switches  described above  can be used in combination. For
  267. example the command:
  268.  
  269.         CATS /VNMC
  270.  
  271. is valid,  and will let you establish a new default catalog file, then
  272. start cataloging a set of disks, with CATS asking to change the volume
  273. label, but without writing any new label to the disk.
  274.  
  275. CATALOGING CONSIDERATIONS
  276.  
  277. CATS has  no limit  as to  how many  disks or directory entries can be
  278. cataloged. However,  the catalog file can grow to substantial size. If
  279. you intend  to store the catalog file on a floppy disk with 360K bytes
  280. storage, you  will be  able to  catalog about  4,530 files,  using the
  281. default record  column length  of 78 columns (two additional bytes per
  282. record are  required for  the terminator--a  carriage return  and line
  283. feed). The  default record  length may be shortened or lengthened (see
  284. CHANGING DEFAULT  SETTINGS), which changes the maximum number of files
  285. that can be stored in a given disk space.
  286.  
  287. To  make  a  sensible  catalog  of  many  disks,  each  disk  must  be
  288. identifiable in  the catalog  list.  Disk  volume  labels  serve  this
  289. purpose, and  therefore each  disk cataloged must have a volume label.
  290. If CATS  finds that  a disk  volume label is missing, the program will
  291. ask you  to furnish one or to exit the program. To help find that disk
  292. later, some thought should go into the volume label choice. Sequential
  293. numbers are  often found  the most  useful, provided these numbers are
  294. then written  on the  disk paper labels. As described above, CATS also
  295. allows you to use volume labels  which are different than those stored
  296. magnetically on the disks.
  297.  
  298. CATS is  streamlined to  act efficiently cataloging a complete library
  299. of disks.  When one  disk has been cataloged, CATS asks if you wish to
  300. continue, and  gives you  the choice of either operating with the same
  301. drive to  catalog another  disk, or  to change  to another  drive.  By
  302. switching between  drives A:  and B:,  for example, you can be loading
  303. one drive  while CATS  is working  on the  disk  in  the  other.  When
  304. finished, a  carriage return  closes the  completed catalog  file  and
  305. exits back to MS-DOS.
  306.  
  307. CATALOG FILE STRUCTURE
  308.  
  309. CATS creates  a catalog  file, listing  each file  found on each disk,
  310. together with  its size, date and time of creation, disk volume label,
  311. and a  possible path.  Space is  reserved to the right in each line to
  312. add any  comments you  wish to  help identify  the  file.  The  sample
  313. records shown  below will help illustrate the structure of the catalog
  314. files produced by CATS.
  315.  
  316. FOOBAR   EXE     89984 83/11-30 01:23 DISK 000001\...................
  317. FOOBARS      D         85/08-02 02:06 DISK 000001\...................
  318. MSDOS    SYS s   17071 84/09-10 13:25 DISK 000001\...................
  319. DISK 000 001 V         85/08-02 00:25 DISK 000001\...................
  320.                 104448 86/08-30 10:21 DISK 000001\ <- Free Space.....
  321.  
  322. The format of each record for the default settings is shown below:
  323.  
  324.  Field description            Default   Appearance
  325. ==================            =======   ==========
  326. Filename                       1- 8     FILENAME
  327. Space1                         9
  328. Extension                     10-12     EXT
  329. Space2                        13
  330. Attrib.symbol                 14        V D S v d s h
  331. File size                     15-22     12345678
  332. Space3                        23
  333. Date                          24-31     86/08-20
  334. Space4                        32
  335. Time                          33-37     18:45
  336. Space5                        38
  337. Volume label                  39-49     VOLUMELABEL
  338. Path from root                50-       \PATH1\PATH2
  339. Fill to end                     -       ....
  340.  
  341. The column  positions provided above are the first and last columns of
  342. each field.  These data  are  useful  for  specifying  the  key  field
  343. positions needed  by by  sorting utilities.  These  set  of  positions
  344. listed are  those created  by CATS when none of the defaults have been
  345. changed. See  Appendix A  for non-  default column positions (see also
  346. CHANGING DEFAULT SETTINGS).
  347.  
  348. The files  are listed  in directory  order, that  is, just as they are
  349. found in the directory on the disk. Directories are listed to identify
  350. their creation  date, but  their display can be suppressed by changing
  351. defaults. The disk volume label is also given a separate line, so that
  352. the volume  label creation  date can  be noted.  (This has  the  added
  353. benefit of  showing, in  the catalog file, the actual volume label, if
  354. you have chosen to use a different one in the catalog.) In addition, a
  355. line will  appear which  has all  spaces in  the file name field. This
  356. line is  reserved for  indicating the  remaining disk  space  and  the
  357. current date.  When a  sort (in  ascending order)  is performed on the
  358. file name  field, all of the disk space information will appear on the
  359. top of the sorted file.
  360.  
  361. The attribute field takes one column in the default mode of CATS, with
  362. one  preceding  space.  The  symbols  V  (volume),  D  (directory),  S
  363. (system), and  h (hidden)  flag symbols  are used.  If D  or S show in
  364. lower case,  then the  directory or  system file  was hidden.  If V is
  365. shown in lower case, then the disk had no physical label, and the CATS
  366. /N switch  was used to prevent one from being created on the disk.  In
  367. that case,  the label  used in  the catalog file name field is the one
  368. supplied by  the user during the CATS cataloging session.  The archive
  369. flag is  not shown in the default configuration. (See CHANGING DEFAULT
  370. SETTINGS to see how to change the flag characters.)
  371.  
  372. Eight columns  are reserved  for the  file  size  in  bytes,  with  no
  373. preceding space  (unless a  comma is  used as  the field separator, in
  374. which case only seven columns are used for the file size). As files of
  375. 10 Megabytes  or more  are rare,  some clear  space will nearly always
  376. appear between  the attribute and size fields. If a file size or total
  377. disk space  exceeds the allocated space, question marks will appear in
  378. the size field.
  379.  
  380. The date  and time  indication is  non-standard but  very logical: The
  381. order from  left to right starts with the largest unit and proceeds to
  382. the smallest.  This format was taken to allow chronological sorting of
  383. the catalog  file based  on a single sort over the whole date and time
  384. field. The  format is: Year/Month-Day Hour:Minute. Seconds are omitted
  385. (unless you  change the defaults--see CHANGING DEFAULT SETTINGS to see
  386. how to  change the  flag characters) to preserve more comment space on
  387. the right  of the  line. If  no  date  or  time  is  recorded  in  the
  388. directory, asterisks  will appear  in the date or time field. Since an
  389. asterisk is  below numbers  in an  ASCII sort, files without a date or
  390. time will  appear at  the beginning  of an  ascending  sort  on  these
  391. fields. Files  without a  date or time are unusual and unorthodox, but
  392. can be  created by  some utilities,  such  as  CHKDSK  from  Microsoft
  393. Corporation. (Rescued  orphan-cluster files with the name FILE0xxx.CHK
  394. are created without a date or time.)
  395.  
  396. The volume  label is  an important  sorting and  searching field. Thus
  397. CATS requires  a disk  volume  label  or  a  label  which  you  supply
  398. interactively. By  searching the  catalog produced by CATS for a given
  399. file and reading the volume label which follows, the disk on which the
  400. file resides  can be quickly identified. Unless the 'N' switch is used
  401. with CATS,  the volume  label will  correspond to the label written in
  402. that disk  directory. Otherwise,  it will be the name you gave for the
  403. volume label  when cataloging  the disk  and should  correspond to the
  404. disk paper label. The label field has eleven characters, with no space
  405. before the following path name.
  406.  
  407. The path  name field  has a  variable length  (limited by  the maximum
  408. record length, which has a default value of 78). If the path name will
  409. not fit  in the  record length  of one  line, it  will be truncated. A
  410. switch in  CATS can be used to turn off the path name field, making it
  411. easier to  add longer  comments to  a file  line (see CHANGING DEFAULT
  412. SETTINGS). The  path name  field is  of somewhat lesser utility on 360
  413. kilobyte diskettes  than hard  disks, as  these usually do not have an
  414. extensive directory  tree structure.  However, this field can be quite
  415. useful for  hard-disk partitions  and for  96  tpi/720  KB  and  high-
  416. density/1.25 MB  floppies. The catalog line showing the remaining disk
  417. space and current date will have the comment:
  418.  
  419.        ' <- Free Space '
  420.  
  421. replacing the path name field.
  422.  
  423. USING THE CATALOG FILE
  424.  
  425.  A  good sorting  program should  be able  to sort  any of the defined
  426. fields of  your catalog,  giving you  alphabetical file name listings,
  427. chronological listings,  disk contents  listings, file size orderings,
  428. etc. Sorting  on the volume label field will concatenate the files for
  429. each disk  in the  catalog. Once a number of disks have been cataloged
  430. with CATS,  the catalog  can be  sorted sequentially to produce almost
  431. any desired  ordering of the listings. Further processing by a utility
  432. such as UNIQ can eliminate duplicate listings, should these eventually
  433. creep into the catalog.
  434.  
  435. A companion  sorting program  called SORTS  is available with CATS for
  436. ordering your  catalog file.  Both CATS  and  SORTS  were  written  in
  437. assembly language,  making them  quite fast.   In addition, SORTS uses
  438. all available  memory to  perform its sorting function.  Catalog files
  439. with up  to 30,000  lines  can  be  sorted,  with  the  sorting  order
  440. determined by  a selection  of multiple key columns, sorting in normal
  441. or reverse  order in  any of  these selected columns. This makes SORTS
  442. one of the most versatile sorting programs available.
  443.  
  444. SORTS contains  a set  of default  sorting  columns  which  match  the
  445. default fields  used in a CATS catalog.  This means you do not have to
  446. determine or  enter the  column positions each time SORTS is run.  The
  447. default column order settings in SORTS are:
  448.  
  449.    Column order setting     Purpose for CATS Catalog file
  450. ---------------------------------------------------------------------
  451.    n=1-8,10-12,14          Sort by name, extension, attribute
  452.  
  453.    s=r15-22,14,1-3         Reverse sort by file size, then attr.,
  454.                            then file extension
  455.    t=r24-25,r27-28,r30-31, Reverse sort by date, then name
  456.       r33-34,r36-37,1-2
  457.    l=39-49,1               Sort by volume label, then name
  458.  
  459.    p=51-67,39-49           Sort by path name, then vol. label
  460.  
  461.    a=14,1-8,10-12          Sort by attribute, then file name
  462.  
  463.    y=r24-25,1-8,10-12      Reverse sort by year, then file name
  464. --------------------------------------------------------------------
  465.  
  466. As an  example, suppose  you wished  to find all files in your catalog
  467. CATS.DIR which  were created  in 1985  with a  given name.   You could
  468. first perform the sort:
  469.  
  470.      SORTS CATS.DIR CATY.DIR/Uy
  471.  
  472. Then, use  a file listing utility to search within and display the new
  473. sorted catalog.   All  files with  a given  name within  1985 will  be
  474. arranged together  in the  new catalog (refer to the documentation for
  475. SORTS for a detailed description of its the command syntax).
  476.  
  477.  
  478. CAUTION: If  you edit  a catalog  and then wish to use CATS to add new
  479. disk volumes,  be sure the catalog file has not been terminated with a
  480. control-Z by  your editor. If it has, that same editor may not be able
  481. to view  the appended  new  volume  information.  The  editor  BSE.EXE
  482. supplied with  the Zenith  Programmer's Utility  Pack is a fine editor
  483. for quickly searching a catalog and adding comments. Moreover, it will
  484. not automatically add end- of-file characters when you finish editing.
  485. For a  quick search for a particular file, Vernon Buerg's LIST.COM (or
  486. ZLIST.COM on  the Z100)  is probably  the fastest  available  file-to-
  487. screen displayer and text-string searcher.
  488.  
  489. CHANGING DEFAULT SETTINGS
  490.  
  491. The default  settings are stored in CATS.COM near the beginning of the
  492. program. Ordinarily, these settings need not be changed. However, some
  493. users may  prefer a  different configuration  of CATS.  To change  the
  494. default catalog  name so  that it  does not have to be supplied on the
  495. command line, use the command:
  496.  
  497.         CATS /C
  498.  
  499. CATS will give the present default catalog name and request a new one.
  500. You may  give a  complete drive and path name or simply the file name,
  501. if the  catalog is  to be on the drive and in the directory from which
  502. CATS is  invoked. For the /C to work, CATS must be able to find itself
  503. on the  disk. If  you must  change the name of the program, change the
  504. file name  CATS.COM within  the program  near its  beginning using the
  505. DEBUG utility.
  506.  
  507. Other configuration parameters may also be changed. However, these may
  508. affect the  format of  the catalog  file, and  therefore should not be
  509. changed unless  you plan  to create  a  completely  new  catalog  (see
  510. CATALOG FILE STRUCTURE).
  511.  
  512. Listed below  are the  configuration parameters  which can  be changed
  513. with the  MS-DOS utility DEBUG. Make these changes with care, and keep
  514. a backup copy of CATS, just in case an error occurs.
  515.  
  516. Load CATS into DEBUG with the command:
  517.  
  518.         DEBUG CATS.COM <cr>
  519.  
  520. (The <cr>  means "RETURN"  or "ENTER".)  Use the  E(xamine) command of
  521. DEBUG to  look at  and make  changes to  a particular  byte at a given
  522. address. For example,
  523.  
  524.          E10A <cr>
  525.  
  526. will show  the current  byte at  address 10A (in hexadecimal). You can
  527. put your  own value  following the  current one, then a <cr>. An ASCII
  528. character can  also be  inserted directly  with the E(xamine) command.
  529. For example, to change the archive flag character to an 'A', you could
  530. use the command:
  531.  
  532.          E104'A' <cr>
  533.  
  534. To see the new set of values in one display, use the D(isplay)
  535. command:
  536.  
  537.          D100 <cr>
  538.  
  539. When you  have finished  reconfiguring CATS  with DEBUG, you can write
  540. CATS back  to the  disk using the W(rite) command. Exit DEBUG with the
  541. Q(uit) command.
  542.  
  543. Address              Default
  544.  (hex)               Value                 Purpose
  545. =======              =======             ========================
  546.  0103                '.'                 comment-field fill-char.
  547.  0104                ' ' (space)         archive flag character
  548.  0105                'h'                 hidden flag character
  549.  0106                'S'                 system flag character
  550.  0107                'V'                 volume flag character
  551.  0108                0FFH                show paths if bit 1=1
  552.  0109                 0                  show seconds if bit 1=1
  553.  010A                04FH                columns in record (78)
  554.  010B                0FFH                reserved
  555.  010C                 0                  reserved
  556.  010D                 1                  show dir. if bit 0=1
  557.  010E                'D'                 directory flag character
  558.  010F                 1                  add space before file ext.
  559.  0110                 2                  col. space for attr. field
  560.  0111                 0                  reserved
  561.  0112                ' ' (space)         field separation character
  562.  0113                '?'                 numeric overflow character
  563.  0114                '*'                 no date fill character
  564.  0115                '*'                 no time fill character
  565.  
  566. The comment-field  fill-line character  is a  period (.)  so that  the
  567. length of  each record  (one line)  is visible. Some sorting utilities
  568. must have fixed record lengths. As you add comments to each file line,
  569. the periods help to keep track of the length of each line.
  570.  
  571. The default archive flag character is a space to make the catalog file
  572. more readable.  There are usually many files on a floppy disk with the
  573. archive flag set, since this flag is set whenever the file is written,
  574. and not reset until a BACKUP utility is run. If any other attribute is
  575. present for  display, the  archive flag will not be shown, even if you
  576. change the character to a visible one.
  577.  
  578. If a  file has only the hidden flag set or the archive and hidden flag
  579. set, the  hidden flag  (h) will  be displayed in the catalog. A hidden
  580. system file  or directory  will have a lower case (S) or (D) character
  581. following the  file name.  The case  of the flag is lowered in CATS by
  582. forcing bit 5 in the flag character's binary code to be high (bits are
  583. numbered from LSB=0 to MSB=7). If you change a flag character from the
  584. initial default to any of the ASCII characters between the space (20H)
  585. and '?'  (3FH), this bit will already be high, so the case of the flag
  586. character will not change when the file hidden flag is detected.
  587.  
  588. If the  byte at  address 108  is changed to 0, the file directory path
  589. names will  not be  shown. This  will leave more space for comments to
  590. identify files.
  591.  
  592. The byte  at address 109 controls whether seconds are displayed in the
  593. time field. If so, it will take three extra columns.
  594.  
  595. You can change the record length with the byte at address 10A. Records
  596. longer than  the standard screen width of 80 columns up to 255 columns
  597. are allowed  by CATS.  Of course,  only 80  columns can  be seen  on a
  598. normal screen,  so an  editor or listing utility capable of horizontal
  599. scrolling would  be needed  to read the remainder of any records wider
  600. than 80  columns. A default of 78 columns per record rather than 80 is
  601. taken so  that if  your console has an automatic line wrapping set on,
  602. you will  not see  the catalog  file apparently double spaced when the
  603. catalog file  is sent  to the  screen. In  addition, having 78 visible
  604. characters in  a record  plus a  carriage return  and linefeed gives a
  605. full record length divisible by 16, helping some sorting utilities.
  606.  
  607. The listing  of directories  can be  suppressed if the byte at address
  608. 10D is 0.
  609.  
  610. One additional  space for comments can be gained by deleting the space
  611. between file  names and  their extensions. This space is controlled by
  612. the byte at address 10F.
  613.  
  614. Additional comment  space can  be gained  by reducing  or removing the
  615. field reserved  for the attribute flag. The byte at address 110 can be
  616. 0, 1,  or 2,  representing the  number of  columns  reserved  for  the
  617. attribute character and preceding field separator.
  618.  
  619. For those  who wish  to use  the CATS  catalog as input to a data base
  620. program, the  field separation character at address 112 can be changed
  621. to a comma, or any other character.
  622.  
  623. CATS ERROR MESSAGES
  624.  
  625. If you  type CATS  without any  command string  following, you will be
  626. shown a help screen with the proper command syntax.
  627.  
  628. The error messages generated by CATS are explained below.
  629.  
  630.         MS-DOS version above 2.0 required.
  631.  
  632. Version 1.x of MS-DOS will not run CATS.
  633.  
  634.         X: is an invalid drive. Currently drives are: A: to ...
  635.  
  636. The drive  name you specified was outside the range recognized by your
  637. system.
  638.  
  639.         Bad catalog disk, path, or file name.
  640.  
  641. The directories  in the  path must  exist.  As  a  precaution  against
  642. typographical errors  creating  new  but  unwanted  directories,  CATS
  643. requires that the directory path to your catalog file exists.
  644.  
  645.         Volume name matches a file name.
  646.  
  647. The volume  label you  specified has  been rejected  because it is the
  648. same as a file name on the root directory of the disk.
  649.  
  650.         Error creating volume label.
  651.  
  652. The following  may cause  this error:  Invalid volume label character;
  653. disk is  flagged write  only; the directory space on the disk is full;
  654. the disk  format was  unrecognized; the  given volume  label matches a
  655. current file name.
  656.  
  657.         Error writing to catalog file: ...
  658.  
  659. The disk  containing the  catalog file  is write  protected or may not
  660. have any  space left. Invalid switch. A switch character following the
  661. '/' on the command line was found not to match the defined ones.
  662.  
  663.         The catalog program was not found.
  664.  
  665. An attempt  to  change  the  configuration  of  CATS  failed,  because
  666. CATS.COM could  not be  found. If  you wish  to rename CATS.COM to any
  667. other name,  the /C  option will  not work  unless you also change the
  668. CATS.COM path  name within  CATS itself. This can be done using DEBUG.
  669. The path  name CATS.COM  appears near  the front of the program. There
  670. are 64 bytes reserved for the path name.
  671.  
  672.         Catalog name was not changed.
  673.  
  674. An invalid  new catalog  name was  supplied, or  a carriage return was
  675. given in response to the request for a new name.
  676.  
  677.          Volume label error.  Sample format: VOLUME  000
  678.  
  679. The /M  make volume  serial label was used.  The volume set label must
  680. end in three numerical digits.
  681.  
  682.  
  683. MS-DOS ERROR MESSAGES WHILE IN CATS
  684.  
  685. The MS-DOS  operating system  can generate  an error  message when you
  686. attempt to  access a  disk drive  containing no disk or with the drive
  687. door open. You will see the messages:
  688.  
  689.         Drive ready error reading drive x:
  690.         Abort, Retry, or Ignore? _
  691.  
  692. If the  disk is  unformated or  has a  bad sector,  you  may  see  the
  693. message:
  694.  
  695.         Disk error reading drive x:
  696.         Abort, Retry, or Ignore? _
  697.  
  698. If you  have left  a write protect tab on the disk, and you attempt to
  699. create a new volume label on the disk, MS-DOS gives:
  700.  
  701.         Write protect error writing drive x:
  702.         Abort, Retry, or Ignore? _
  703.  
  704. You should  put a  valid disk  in the drive, close the door, and press
  705. 'R' for Retry. CATS can then continue. If you press 'A' for abort, the
  706. system will  return to  the operating  system prompt on the drive from
  707. which CATS was invoked.
  708.  
  709. APPENDIX A: Alternative CATS File Formats
  710.  
  711. When some of the default settings are changed in CATS.COM using DEBUG,
  712. the format  of the catalog file records will also change. This affects
  713. the beginning of the sorting field columns. Below is a list of the new
  714. column positions for a sample of changed switches within CATS:
  715.  
  716.    Field       ------------ Column positions ----------
  717. description    Default    Alternate record format          Appearance
  718. ============== ====== =================================    ==========
  719. Filename        1- 8   1- 8   1- 8   1- 8   1- 8   1- 8    FILENAME
  720. Space           9      **     9      **     9      **
  721. Extension      10-12   9-11  10-12   9-11  10-12   9-11    EXT
  722. Space          13     12      **     **     **     **
  723. Attribute      14     13     13     12      **     **      V D S d s h
  724. File size      15-22  14-21  14-21  13-20  13-20  12-19    mmttthhh
  725. Date           24-31  23-30  23-30  22-29  22-29  21-28    86/08-20
  726. Time           33-37+ 32-36+ 32-36+ 31-35+ 31-35+ 30-34+   18:45
  727. Volume label   39-49  38-48  38-48  37-47  37-47  36-46    volumelabel
  728. Path from root 50-    49-    49-    48-    48-    47-      \path\path
  729. Fill to end      -                                         ....
  730. _____________________________________________________________________
  731. ** Position deleted by changing defaults.
  732.  +  An additional  three positions  are used  for optional  display of
  733. seconds.
  734.  
  735. If the defaults are changed to display seconds, add three to the width
  736. of the  key field  length for  sorting time, and add three each to the
  737. start and end positions for volume label and to the start position for
  738. path.
  739.  
  740.  
  741. DISTRIBUTION:
  742.  
  743. CATS is  released for use by members of the Capital Heath Users' Group
  744. by its  initial distribution.   With Version 1.8, CATS is released for
  745. distribution into  the public  domain by its author, W. C. Parke. CATS
  746. is copyrighted 1986 by W. C. Parke, 1820 S Street NW, Washington, D.C.
  747. 20009, telephone (202) 667-4094.
  748.  
  749. CATS may  be freely copied and used, but may not be sold for profit or
  750. bundled with products offered for sale without expressed permission of
  751. the author.
  752.  
  753.